Skip to content

docs: SECURITY.md + security architecture + threat model#69

Merged
vazra merged 1 commit into
mainfrom
docs/security-policy
Apr 29, 2026
Merged

docs: SECURITY.md + security architecture + threat model#69
vazra merged 1 commit into
mainfrom
docs/security-policy

Conversation

@vazra
Copy link
Copy Markdown
Owner

@vazra vazra commented Apr 29, 2026

Adds OSS-audience security documentation aimed at researchers and downstream auditors. Rewrites SECURITY.md (private GH advisories, safe harbor, scope, timelines), adds /operations/security-architecture/ (components, primitives, controls), adds /operations/threat-model/ (trust principals, in/out of scope, design trade-offs, invariants to verify). Care taken to describe design choices without giving attackers a roadmap.

…eat model

Three new/updated user-facing security docs aimed at OSS auditors and
researchers:

- SECURITY.md (rewrite): private vulnerability reporting via GitHub
  advisories; safe-harbor language; explicit in/out of scope; clear
  triage timelines and credit policy.
- docs/operations/security-architecture.md (new): components, crypto
  primitives + parameters, auth/authz model, network exposure,
  outbound-traffic surfaces, validation pipelines, audit/logging,
  DoS controls, build pipeline, recommended audit entry points,
  documented design trade-offs.
- docs/operations/threat-model.md (new): trust principals, in-scope
  adversaries, explicit out-of-scope adversaries, ASCII boundary
  diagram, six documented design trade-offs (super_admin = host root,
  master_secret single-root-of-trust, recipes TOFU, audit operator-
  trust, tls.mode off permitted, unsigned release artifacts), and a
  list of cross-cutting invariants a researcher should expect to
  verify.

The Operations sidebar autogenerates so no astro.config edit is needed.
Care taken to describe the design at the level a researcher needs
without giving attackers a roadmap: parameters and primitives are
listed, but specific bypass techniques and unfixed weaknesses are not.
@vazra vazra merged commit 05e1faa into main Apr 29, 2026
4 of 5 checks passed
@vazra vazra deleted the docs/security-policy branch April 29, 2026 23:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant